FiberType
Operations on a running Fiber`2, the handle returned by
Flow.fork.Specification
Kind
Type
Members
6
Examples
0
dumpSignature
Fiber.dump fiber
joinSignature
Fiber.join fiber
awaitSignature
Fiber.await fiber
pollSignature
Fiber.poll fiber
interruptSignature
Fiber.interrupt fiber
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Operations | ||
| dump | Fiber.dump fiber | Returns a snapshot of the fiber's diagnostic metadata. |
| join | Fiber.join fiber | Waits for a fiber and returns its value, failing the same way the fiber failed. |
| await | Fiber.await fiber | Waits for a fiber and returns its , never failing. |
| poll | Fiber.poll fiber | Returns the fiber's exit if it has settled, without waiting. |
| interrupt | Fiber.interrupt fiber | Signals a fiber to stop, waits for its cleanup, and returns its final exit. |
| Metadata | this.Metadata | Diagnostic metadata for the running fiber. |
Operations
kind:member
kind:member
Waits for a fiber and returns its value, failing the same way the fiber failed.
Parameters
| Name | Type | Description |
|---|---|---|
| fiber | Fiber<'error, 'value> | The fiber to join. |
Returns
Flow<'env, 'error, 'value>
Verification Examples
let loadProfile : Flow<unit, string, string> = Flow.ok "profile"
let loadOrders : Flow<unit, string, int list> = Flow.ok [ 1; 2 ]
let page =
flow {
let! fiber = Flow.fork loadProfile
let! orders = loadOrders
let! profile = Fiber.join fiber
return profile, orders
}kind:member
Waits for a fiber and returns its Exit`2, never failing.
Parameters
| Name | Type | Description |
|---|---|---|
| fiber | Fiber<'error, 'value> | The fiber to wait for. |
Returns
Flow<'env, 'none, Exit<'value, 'error>>
Verification Examples
flow {
match! Fiber.await fiber with
| Exit.Success value -> return Some value
| Exit.Failure _ -> return None
}kind:member
kind:member